home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2001 May / SGI IRIX Base Documentation 2001 May.iso / usr / share / catman / p_man / cat3 / X11 / XInternAtom.z / XInternAtom
Encoding:
Text File  |  1998-10-30  |  7.5 KB  |  199 lines
  1.  
  2.  
  3.  
  4.      XXXXIIIInnnntttteeeerrrrnnnnAAAAttttoooommmm((((3333XXXX11111111))))  XXXX VVVVeeeerrrrssssiiiioooonnnn 11111111 ((((RRRReeeelllleeeeaaaasssseeee 6666....3333))))   XXXXIIIInnnntttteeeerrrrnnnnAAAAttttoooommmm((((3333XXXX11111111))))
  5.  
  6.  
  7.  
  8.      NNNNAAAAMMMMEEEE
  9.           XInternAtom, XInternAtoms, XGetAtomName, XGetAtomNames -
  10.           create or return atom names
  11.  
  12.      SSSSYYYYNNNNTTTTAAAAXXXX
  13.           Atom XInternAtom(_d_i_s_p_l_a_y, _a_t_o_m__n_a_m_e, _o_n_l_y__i_f__e_x_i_s_t_s)
  14.                 Display *_d_i_s_p_l_a_y;
  15.                 char *_a_t_o_m__n_a_m_e;
  16.                 Bool _o_n_l_y__i_f__e_x_i_s_t_s;
  17.  
  18.           Status XInternAtoms(_d_i_s_p_l_a_y, _n_a_m_e_s, _c_o_u_n_t, _o_n_l_y__i_f__e_x_i_s_t_s,
  19.           _a_t_o_m_s__r_e_t_u_r_n)
  20.                 Display *_d_i_s_p_l_a_y;
  21.                 char **_n_a_m_e_s;
  22.                 int _c_o_u_n_t;
  23.                 Bool _o_n_l_y__i_f__e_x_i_s_t_s;
  24.                 Atom *_a_t_o_m_s__r_e_t_u_r_n;
  25.  
  26.           char *XGetAtomName(_d_i_s_p_l_a_y, _a_t_o_m)
  27.                 Display *_d_i_s_p_l_a_y;
  28.                 Atom _a_t_o_m;
  29.  
  30.           Status XGetAtomNames(_d_i_s_p_l_a_y, _a_t_o_m_s, _c_o_u_n_t, _n_a_m_e_s__r_e_t_u_r_n)
  31.                 Display *_d_i_s_p_l_a_y;
  32.                 Atom *_a_t_o_m_s;
  33.                 int _c_o_u_n_t;
  34.                 char **_n_a_m_e_s__r_e_t_u_r_n;
  35.  
  36.      AAAARRRRGGGGUUUUMMMMEEEENNNNTTTTSSSS
  37.           _a_t_o_m      Specifies the atom for the property name you want
  38.                     returned.
  39.  
  40.           _a_t_o_m_s     Specifies the array of atoms.
  41.  
  42.           _a_t_o_m__n_a_m_e Specifies the name associated with the atom you
  43.                     want returned.
  44.  
  45.           _a_t_o_m_s__r_e_t_u_r_n
  46.                     Returns the atoms.
  47.  
  48.           _c_o_u_n_t     Specifies the number of atom names in the array.
  49.  
  50.           _c_o_u_n_t     Specifies the number of atoms in the array.
  51.  
  52.           _d_i_s_p_l_a_y   Specifies the connection to the X server.
  53.  
  54.           _n_a_m_e_s     Specifies the array of atom names.
  55.  
  56.           _n_a_m_e_s__r_e_t_u_r_n
  57.                     Returns the atom names.
  58.  
  59.           _o_n_l_y__i_f__e_x_i_s_t_s
  60.  
  61.  
  62.  
  63.      Page 1                                          (printed 4/30/98)
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70.      XXXXIIIInnnntttteeeerrrrnnnnAAAAttttoooommmm((((3333XXXX11111111))))  XXXX VVVVeeeerrrrssssiiiioooonnnn 11111111 ((((RRRReeeelllleeeeaaaasssseeee 6666....3333))))   XXXXIIIInnnntttteeeerrrrnnnnAAAAttttoooommmm((((3333XXXX11111111))))
  71.  
  72.  
  73.  
  74.                     Specifies a Boolean value that indicates whether
  75.                     the atom must be created.
  76.  
  77.      DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  78.           The _X_I_n_t_e_r_n_A_t_o_m function returns the atom identifier
  79.           associated with the specified atom_name string.  If
  80.           only_if_exists is _F_a_l_s_e, the atom is created if it does not
  81.           exist.  Therefore, _X_I_n_t_e_r_n_A_t_o_m can return _N_o_n_e.  If the atom
  82.           name is not in the Host Portable Character Encoding, the
  83.           result is implementation-dependent.  Uppercase and lowercase
  84.           matter; the strings ``thing'', ``Thing'', and ``thinG'' all
  85.           designate different atoms. The atom will remain defined even
  86.           after the client's connection closes.  It will become
  87.           undefined only when the last connection to the X server
  88.           closes.
  89.  
  90.           _X_I_n_t_e_r_n_A_t_o_m can generate _B_a_d_A_l_l_o_c and _B_a_d_V_a_l_u_e errors.
  91.  
  92.           The _X_I_n_t_e_r_n_A_t_o_m_s function returns the atom identifiers
  93.           associated with the specified names.  The atoms are stored
  94.           in the atoms_return array supplied by the caller.  Calling
  95.           this function is equivalent to calling _X_I_n_t_e_r_n_A_t_o_m for each
  96.           of the names in turn with the specified value of
  97.           only_if_exists, but this function minimizes the number of
  98.           round-trip protocol exchanges between the client and the X
  99.           server.
  100.  
  101.           This function returns a nonzero status if atoms are returned
  102.           for all of the names; otherwise, it returns zero.
  103.  
  104.           _X_I_n_t_e_r_n_A_t_o_m_s can generate _B_a_d_A_l_l_o_c and _B_a_d_V_a_l_u_e errors.
  105.  
  106.           The _X_G_e_t_A_t_o_m_N_a_m_e function returns the name associated with
  107.           the specified atom.  If the data returned by the server is
  108.           in the Latin Portable Character Encoding, then the returned
  109.           string is in the Host Portable Character Encoding.
  110.           Otherwise, the result is implementation-dependent.  To free
  111.           the resulting string, call _X_F_r_e_e.
  112.  
  113.           _X_G_e_t_A_t_o_m_N_a_m_e can generate a _B_a_d_A_t_o_m error.
  114.  
  115.           The _X_G_e_t_A_t_o_m_N_a_m_e_s function returns the names associated with
  116.           the specified atoms.  The names are stored in the
  117.           names_return array supplied by the caller.  Calling this
  118.           function is equivalent to calling _X_G_e_t_A_t_o_m_N_a_m_e for each of
  119.           the atoms in turn, but this function minimizes the number of
  120.           round-trip protocol exchanges between the client and the X
  121.           server.
  122.  
  123.           This function returns a nonzero status if names are returned
  124.           for all of the atoms; otherwise, it returns zero.
  125.  
  126.  
  127.  
  128.  
  129.      Page 2                                          (printed 4/30/98)
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136.      XXXXIIIInnnntttteeeerrrrnnnnAAAAttttoooommmm((((3333XXXX11111111))))  XXXX VVVVeeeerrrrssssiiiioooonnnn 11111111 ((((RRRReeeelllleeeeaaaasssseeee 6666....3333))))   XXXXIIIInnnntttteeeerrrrnnnnAAAAttttoooommmm((((3333XXXX11111111))))
  137.  
  138.  
  139.  
  140.           _X_G_e_t_A_t_o_m_N_a_m_e_s can generate a _B_a_d_A_t_o_m error.
  141.  
  142.      DDDDIIIIAAAAGGGGNNNNOOOOSSSSTTTTIIIICCCCSSSS
  143.           _B_a_d_A_l_l_o_c  The server failed to allocate the requested
  144.                     resource or server memory.
  145.  
  146.           _B_a_d_A_t_o_m   A value for an Atom argument does not name a
  147.                     defined Atom.
  148.  
  149.           _B_a_d_V_a_l_u_e  Some numeric value falls outside the range of
  150.                     values accepted by the request.  Unless a specific
  151.                     range is specified for an argument, the full range
  152.                     defined by the argument's type is accepted.  Any
  153.                     argument defined as a set of alternatives can
  154.                     generate this error.
  155.  
  156.      SSSSEEEEEEEE AAAALLLLSSSSOOOO
  157.           XFree(3X11), XGetWindowProperty(3X11)
  158.           _X_l_i_b - _C _L_a_n_g_u_a_g_e _X _I_n_t_e_r_f_a_c_e
  159.  
  160.  
  161.  
  162.  
  163.  
  164.  
  165.  
  166.  
  167.  
  168.  
  169.  
  170.  
  171.  
  172.  
  173.  
  174.  
  175.  
  176.  
  177.  
  178.  
  179.  
  180.  
  181.  
  182.  
  183.  
  184.  
  185.  
  186.  
  187.  
  188.  
  189.  
  190.  
  191.  
  192.  
  193.  
  194.  
  195.      Page 3                                          (printed 4/30/98)
  196.  
  197.  
  198.  
  199.